Azure Engagement System API - Implementation Template
Developer guide
This document provides information generated from the DataWeave scripts included in the project, such as function definitions, variable definitions, and data mapping tables.
| Module | Description |
|---|---|
| web-enagament-request-mapping | Provides mappings to transform from input request to target NoSQL document data format. |
| webengagement-hls-response-mapping | Provides mappings to transform from NoSQL document to API specification response data format. |
web-enagament-request-mapping
HLS to Azure web engagement response mapping
Source:
./src/main/resources/dwl/web-enagament-request-mapping.dwl
Mapping Tables
Maps HLS to Azure web engagement format mapping
| Azure | HLS | Description |
|---|---|---|
| id | individualId | The unique individualId. |
| individualId | individualId | Id of the patient user account. |
| emailAddress | emailAddress | The email Id of the patient user account. |
| sessionId | sessionId | The unique number assigned to the user's session for the duration of the visit. |
| pageViews | pageViews | The number of times the page is viewed. |
| averageTimeonPage | averageTimeonPage | The average time spent on page. |
| memberName | memberName | The name of the patient. |
| contentName | contentName | The name of the content or page that the patient visited on the websit. |
| contentType | contentType | The type of the content or page that the patient visited on the website. E.g article or video. |
| lastVisitedDate | lastVisitedDate | The count of a website's total page views divided by the total number of sessions that have taken place. |
| lastModifiedDate | lastModifiedDate | The average duration of the session in seconds. |
| auditInfo.createdDate | createdDate | The Created date. |
| auditInfo.createdBy | createdBy | CreatedBy user. |
| auditInfo.updatedDate | updatedDate | The updated date. |
| auditInfo.updatedBy | updatedBy | The name of user updated. |
| auditInfo.isDeleted | isDeleted | Default to false. |
webengagement-hls-response-mapping
Azure to HLS web engagement response mapping
Source:
./src/main/resources/dwl/webengagement-hls-response-mapping.dwl
Mapping Tables
Maps Azure to HLS web engagement format mapping
| HLS | Azure | Description |
|---|---|---|
| individualId | individualId | Id of the patient user account. |
| emailAddress | emailAddress | The email Id of the patient user account. |
| sessionId | sessionId | The unique number assigned to the user's session for the duration of the visit. |
| pageViews | pageViews | The number of times the page is viewed. |
| averageTimeonPage | averageTimeonPage | The average time spent on page. |
| memberName | memberName | The name of the patient. |
| contentName | contentName | The name of the content or page that the patient visited on the websit. |
| contentType | contentType | The type of the content or page that the patient visited on the website. E.g article or video. |
| lastVisitedDate | lastVisitedDate | The count of a website's total page views divided by the total number of sessions that have taken place. |
| lastModifiedDate | lastModifiedDate | The average duration of the session in seconds. |
| auditInfo.createdDate | createdDate | The Created date. |
| auditInfo.createdBy | createdBy | CreatedBy user. |
| auditInfo.updatedDate | updatedDate | The updated date. |
| auditInfo.updatedBy | updatedBy | The name of user updated. |
| auditInfo.isDeleted | isDeleted | Default to false. |